<!DOCTYPE html>
<html  >
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="keywords" content="teedoc, markdown, jupyter notebook, html, document generation, alternative gitbook, website generation, static website">
    <meta name="description" content="teedoc, convert markdown or jupyter notbook into html static webpage">
    <meta name="generator" content="teedoc">
    <meta name="markdown-generator" content="teedoc-plugin-markdown-parser">
        <link rel="stylesheet" href="/static/css/theme_default/prism.min.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/dark.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/light.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/custom.css" type="text/css"/>
        <script src="/static/js/theme_default/jquery.min.js"></script>
        <script src="/static/js/theme_default/pre_main.js"></script>
        <link rel="stylesheet" href="/static/css/search/style.css" type="text/css"/>
        <script>
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?91ac08174b63c5c88f71f8a94004a1fe";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();
</script>
    <title>teedoc - teedoc</title>
</head>
<body>
    
            <div id="navbar">
                <div id="navbar_menu">
                    <a class="site_title" href="/en/"><img class="site_logo" src="/static/image/logo.png" alt="teedoc logo"><h2>teedoc</h2></a>
                    <a id="navbar_menu_btn"></a>
                </div>
                <div id="navbar_items">
                    <div>
                        <ul id="nav_left">
<li class="active"><a  href="/get_started/en/">Install</a></li>
<li class=""><a  href="/develop/en/">Develop</a></li>
</ul>

                    </div>
                    <div>
                        <ul id="nav_right">
<li class=""><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li class="sub_items "><a  href="">语言: English</a><ul><li class=""><a  href="/get_started/zh/">中文</a></li>
<li class="active"><a  href="/get_started/en/">English</a></li>
</ul></li>
</ul>

                        <ul class="nav_plugins"><li><a id="themes" class="light"></a></li></ul><ul class="nav_plugins"><li><a id="search"><span class="icon"></span><span class="placeholder">Search</span>
                            <div id="search_hints">
                                <span id="search_input_hint">Keywords separated by space</span>
                                <span id="search_loading_hint">Loading, wait please ...</span>
                                <span id="search_download_err_hint">Download error, please check network and refresh again</span>
                                <span id="search_other_docs_result_hint">Result from other docs</span>
                                <span id="search_curr_doc_result_hint">Result from current doc</span>
                            </div></a></li></ul>
                    </div>
                </div>
            </div>
    
        <div id="wrapper">
            
            <div id="sidebar_wrapper">
                <div id="sidebar">
                    <div id="sidebar_title">
                        
                    </div>
                    <ul class="show">
<li class="active with_link"><a href="/get_started/en/index.html"><span class="label">Introduction to teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/install/index.html"><span class="label">Install teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/start.html"><span class="label">Start writing document</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/write_attention.html"><span class="label">Pay attention to when writing documents</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/plugins/index.html"><span class="label">Plugin</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/plugins/themes.html"><span class="label">Theme Plugin</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/plugins/others.html"><span class="label">Other plugins</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/syntax/syntax_markdown.html"><span class="label">markdown syntax</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy.html"><span class="label">Deployment</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_github_pages.html"><span class="label">Deploy to github</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_nginx.html"><span class="label">Use nginx to deploy to the server</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_cdn.html"><span class="label">Use CDN to accelerate website</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/usage/seo.html"><span class="label">SEO (Optimize for Search Engines)</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/sites.html"><span class="label">Website using teedoc</span><span class=""></span></a></li>
<li class="not_active no_link"><a><span class="label">More samples</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Second-level subdirectory example</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Sample three-level sub-directory</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc1.html"><span class="label">Article 1</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc2.html"><span class="label">Article 2</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="https://github.com/teedoc/teedoc" target="_blank"><span class="label">This is a external link</span><span class=""></span></a></li>
</ul>
</li>
</ul>

                </div>
            </div>
            <div id="menu_wrapper">
                                    <div id="menu">
                                    </div>
                                </div>
            <div id="article">
                <div id="content_wrapper">
                    <div id="content_body">
                        <div id="article_title">
                            <h1>teedoc</h1>
                        </div>
                        <div id="article_tags">
                            <ul></ul>
                        </div>
                        <div id="article_content">
                            <p>Official website: <a href="https://teedoc.github.io/">teedoc.github.io</a><br />
Source file of this document: <a href="https://github.com/teedoc/teedoc.github.io">github.com/teedoc/teedoc.github.io</a><br />
Source code: <a href="https://github.com/teedoc/teedoc">https://github.com/teedoc/teedoc</a> Welcome star</p>

<p>Convert documents in <code>Markdown</code> or <code>Jupyter Notebook</code> format to <code>HTML</code> web pages</p>

<p><code>teedoc</code> can be used in the following scenarios:</p>

<ul>
<li>Build a document website, and preferably support multiple documents and custom pages</li>
<li>Build a <code>WiKi</code> website</li>
<li>Build personal or corporate knowledge base</li>
<li>Build personal or corporate website</li>
</ul>

<h2 id="features">Features</h2>

<ul>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Simple to use, cross-platform, only dependent on <code>Python3</code></li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> The deployment is simple, the generated website is a fully static page, which can be deployed directly by copying to the server or uploading to a third party organization</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Easy to write, using Markdown syntax</li>
<li><input type="checkbox" class="task-list-item-checkbox" disabled> Jupyter notebook support</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-document support</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Plug-in support</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-theme support (implemented by plugin)</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Control the style accurate to the page through css (implemented by customizing the id and class of each page)</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-level directory support</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-language support (manual translation) (Internationalization/i18n)</li>
<li><input type="checkbox" class="task-list-item-checkbox" disabled> Multilingual support (automatic translation)</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-version support (implementation method is the same as multi-language)</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Search support</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> SEO friendly</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Real-time preview of changes</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Multi-threaded construction, faster construction speed</li>
<li><input type="checkbox" class="task-list-item-checkbox" disabled> Blog support</li>
</ul>

<h2 id="similar-tools">Similar tools</h2>

<p>In fact, there are already many tools of this type. Just choose one according to your needs.</p>

<ul>
<li>docusaurus: The UI layout of teedoc is almost similar to it, but it uses vue to write, teedoc is native js, if you are using vue, you can consider this</li>
<li>gitbook: a tool that used to be very useful, but it is no longer maintained by the official website</li>
<li>docsify: Only one page is needed. Markdown is rendered in the browser instead of pre-rendered into HTML. The advantage is that it is lightweight, but SEO is not friendly. You can use its SSR function, written in nodejs</li>
<li>readthedocs: A tool used by many open source projects. It also has a website service like gitbook. You can start writing documents after registering and logging in. You can also download the software to generate the website yourself, which is friendly to RST format support</li>
</ul>

<p>If you have choice difficulties, you are recommended to use teedoc if you meet some of the following conditions:</p>

<ul>
<li>Does the function meet your needs?</li>
<li>Does the interface meet your aesthetics (you can customize css, or change the theme plug-in)</li>
<li>Familiar with Python? You can customize the plugin at any time</li>
</ul>

<h2 id="some-usage-suggestions">Some usage suggestions</h2>

<ul>
<li>Add <code>Generate with teedoc</code> in footer to help more people discover teedoc and promote project growth</li>
<li>Use the template project to start a new document project, you can run it first, and then modify it according to your own needs, so that you can get started faster</li>
</ul>

                        </div>
                    </div>
                    <div id="previous_next">
                        <div id="previous">
                            
                        </div>
                        <div id="next">
                            <a href="/get_started/en/install/index.html"><span class="label">Install teedoc</span><span class="icon"></span></a>
                        </div>
                    </div>
                </div>
                <div id="toc">
                    <div>
                        <ul>
  <li><a href="#features">Features</a></li>
  <li><a href="#similar-tools">Similar tools</a></li>
  <li><a href="#some-usage-suggestions">Some usage suggestions</a></li>
</ul>

                    </div>
                </div>
            </div>
        </div>
        <a id="to_top" href="#"></a>
        <div id="doc_footer">
                        
            <div id="footer">
                <div id="footer_top">
                    <ul>
<li><a>Links</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">Build with teedoc</a></li>
<li><a target="_blank" href="https://neucrack.com">Copyright © 2021 Neucrack</a></li>
<li><a  href="/sitemap.xml">Sitemap</a></li>
</ul>
</li>
<li><a>Source code</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li><a target="_blank" href="https://github.com/teedoc/teedoc.github.io">website source files</a></li>
</ul>
</li>
</ul>

                </div>
                <div id="footer_bottom">
                    <ul>
<li><a target="_blank" href="https://beian.miit.gov.cn">*ICP备********号-1</a></li>
<li><a target="_blank" href="https://beian.miit.gov.cn/#/Integrated/index">*公网安备**************号</a></li>
</ul>

                </div>
            </div>
                    </div>
</body>
<script src="/static/js/theme_default/main.js"></script>
<script src="/static/css/theme_default/prism.min.js"></script>
<script src="/static/js/custom.js"></script>
<script src="/static/js/search/main.js"></script>
</html>
